<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>content | My Python Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          content <span class="m-thin">module</span>
        </h1>
        <p>This overwrites the docstring for <a class="m-doc" href="content.html">content</a>.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#packages">Modules</a></li>
                <li><a href="#classes">Classes</a></li>
                <li><a href="#enums">Enums</a></li>
                <li><a href="#functions">Functions</a></li>
                <li><a href="#data">Data</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>This is detailed module docs. I kinda <em>hate</em> how it needs to be indented,
tho. Below is an included file to test file path is supplied somewhat
correctly (relative to the input dir):</p>
<pre># This module has an external summary
</pre>
        <section id="namespaces">
          <h2><a href="#namespaces">Modules</a></h2>
          <dl class="m-doc">
            <dt>module <a href="content.docstring_summary.html" class="m-doc">docstring_summary</a></dt>
            <dd>This module retains summary from the docstring</dd>
            <dt>module <a href="content.submodule.html" class="m-doc">submodule</a></dt>
            <dd>This submodule has an external summary.</dd>
          </dl>
        </section>
        <section id="classes">
          <h2><a href="#classes">Classes</a></h2>
          <dl class="m-doc">
            <dt>class <a href="content.Class.html" class="m-doc">Class</a></dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.Class.html">Class</a>.</dd>
            <dt>class <a href="content.ClassDocumentingItsMembers.html" class="m-doc">ClassDocumentingItsMembers</a></dt>
            <dd>This class documents its members directly in its own directive</dd>
            <dt>class <a href="content.ClassWithSlots.html" class="m-doc">ClassWithSlots</a></dt>
            <dd>This class has slots and those have to be documented externally</dd>
            <dt>class <a href="content.ClassWithSummary.html" class="m-doc">ClassWithSummary</a></dt>
            <dd>This class has summary from the docstring</dd>
          </dl>
        </section>
        <section id="enums">
          <h2><a href="#enums">Enums</a></h2>
          <dl class="m-doc">
            <dt id="Enum">
              <span class="m-doc-wrap-bumper">class <a href="#Enum" class="m-doc-self">Enum</a>(enum.Enum): </span><span class="m-doc-wrap"></span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.html#Enum">Enum</a>, but doesn't
add any detailed block.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">class <a href="#EnumWithSummary" class="m-doc">EnumWithSummary</a>(enum.Enum): </span><span class="m-doc-wrap"><a href="#EnumWithSummary-VALUE" class="m-doc">VALUE</a> = 0
              <a href="#EnumWithSummary-ANOTHER" class="m-doc">ANOTHER</a> = 1
              <a href="#EnumWithSummary-THIRD" class="m-doc">THIRD</a> = 3</span>
            </dt>
            <dd>This summary is preserved</dd>
          </dl>
        </section>
        <section id="functions">
          <h2><a href="#functions">Functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#exception_docs" class="m-doc">exception_docs</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>This one documents raised exceptions in an (otherwise unneeded) detail
view</dd>
            <dt id="foo">
              <span class="m-doc-wrap-bumper">def <a href="#foo" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">a, b)</span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.html#foo">foo()</a>, but doesn't
add any detailed block.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#foo_with_details" class="m-doc">foo_with_details</a>(</span><span class="m-doc-wrap">a, b)</span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.html#foo_with_details">foo_with_details()</a>.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#full_docstring" class="m-doc">full_docstring</a>(</span><span class="m-doc-wrap">a, b) -&gt; str</span>
            </dt>
            <dd>This function has a full docstring.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#function_with_summary" class="m-doc">function_with_summary</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>This function has summary from the docstring</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#param_docs" class="m-doc">param_docs</a>(</span><span class="m-doc-wrap">a: int,
              b,
              c: float) -&gt; str</span>
            </dt>
            <dd>Detailed param docs and annotations</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#param_docs_wrong" class="m-doc">param_docs_wrong</a>(</span><span class="m-doc-wrap">a, b)</span>
            </dt>
            <dd>Should give warnings</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#this_function_has_bad_docs" class="m-doc">this_function_has_bad_docs</a>(</span><span class="m-doc-wrap">a, b)</span>
            </dt>
            <dd></dd>
          </dl>
        </section>
        <section id="data">
          <h2><a href="#data">Data</a></h2>
          <dl class="m-doc">
            <dt id="ANOTHER_DOCUMENTED_INSIDE_MODULE">
              <a href="#ANOTHER_DOCUMENTED_INSIDE_MODULE" class="m-doc-self">ANOTHER_DOCUMENTED_INSIDE_MODULE</a> = 3
            </dt>
            <dd>In-module summary for another data</dd>
            <dt id="CONSTANT">
              <a href="#CONSTANT" class="m-doc-self">CONSTANT</a>: float = 3.14
            </dt>
            <dd>This is finally a docstring for <a class="m-doc" href="content.html#CONSTANT">CONSTANT</a></dd>
            <dt id="DATA_DOCUMENTED_INSIDE_MODULE">
              <a href="#DATA_DOCUMENTED_INSIDE_MODULE" class="m-doc-self">DATA_DOCUMENTED_INSIDE_MODULE</a>: float = 6.28
            </dt>
            <dd>In-module summary for the data member</dd>
            <dt>
              <a href="#DATA_WITH_DETAILS" class="m-doc">DATA_WITH_DETAILS</a>: str = &#x27;heyoo&#x27;
            </dt>
            <dd>This is finally a docstring for <a class="m-doc" href="content.html#DATA_WITH_DETAILS">DATA_WITH_DETAILS</a></dd>
            <dt>
              <a href="#DATA_WITH_DETAILS_BUT_NO_SUMMARY_NEITHER_TYPE" class="m-doc">DATA_WITH_DETAILS_BUT_NO_SUMMARY_NEITHER_TYPE</a> = None
            </dt>
            <dd></dd>
          </dl>
        </section>
        <section>
          <h2>Enum documentation</h2>
          <section class="m-doc-details" id="EnumWithSummary"><div>
            <h3>
              class content.<wbr /><a href="#EnumWithSummary" class="m-doc-self">EnumWithSummary</a>(enum.Enum)
            </h3>
            <p>This summary is preserved</p>
            <table class="m-table m-fullwidth m-flat m-doc">
              <thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
              <tbody>
                <tr>
                  <td><a href="#EnumWithSummary-VALUE" id="EnumWithSummary-VALUE" class="m-doc-self">VALUE</a></td>
                  <td>
<p>Value docs where this is treated as summary.</p>
<p>And this as detailed docs by the raw docstring parser, but the theme doesn&#x27;t
distinguish between them so they get merged together.</p>
                  </td>
                </tr>
                <tr>
                  <td><a href="#EnumWithSummary-ANOTHER" id="EnumWithSummary-ANOTHER" class="m-doc-self">ANOTHER</a></td>
                  <td>
<p>This value is documented from within the <code>enum</code>
directive...</p>
                  </td>
                </tr>
                <tr>
                  <td><a href="#EnumWithSummary-THIRD" id="EnumWithSummary-THIRD" class="m-doc-self">THIRD</a></td>
                  <td>
<p>... while this comes from the <code>enumvalue</code> directive.</p>
                  </td>
                </tr>
              </tbody>
            </table>
<p>And this is detailed docs added to the docstring summary. <a class="m-doc" href="content.html#EnumWithSummary-VALUE">VALUE</a>!!</p>
          </div></section>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="exception_docs"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#exception_docs" class="m-doc-self">exception_docs</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>This one documents raised exceptions in an (otherwise unneeded) detail
view</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Exceptions</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">ValueError</td>
                  <td>This thing fires</td>
                </tr>
                <tr>
                  <td>ValueError</td>
                  <td>This <em>same</em> thing fires <em>also</em> for this reason</td>
                </tr>
                <tr>
                  <td>RuntimeError</td>
                  <td>This another thing fires too</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="foo_with_details"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#foo_with_details" class="m-doc-self">foo_with_details</a>(</span><span class="m-doc-wrap">a, b)</span></span>
            </h3>
            <p>This overwrites the docstring for <a class="m-doc" href="content.html#foo_with_details">foo_with_details()</a>.</p>
<div class="m-note m-info">
Detailed docs for this function</div>
          </div></section>
          <section class="m-doc-details" id="full_docstring"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#full_docstring" class="m-doc-self">full_docstring</a>(</span><span class="m-doc-wrap">a, b) -&gt; str</span></span>
            </h3>
            <p>This function has a full docstring.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First parameter</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second</td>
                </tr>
              </tbody>
            </table>
<p>It takes one parameter and also another, which are documented externally,
but not overwriting the in-source docstring. The details are in two
paragraphs, each wrapped in its own `&lt;p&gt;`, but not additionally formatted
or parsed in any way.</p>
<p>Like this.</p>
          </div></section>
          <section class="m-doc-details" id="function_with_summary"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#function_with_summary" class="m-doc-self">function_with_summary</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>This function has summary from the docstring</p>
<p>This function has external details but summary from the docstring.</p>
          </div></section>
          <section class="m-doc-details" id="param_docs"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#param_docs" class="m-doc-self">param_docs</a>(</span><span class="m-doc-wrap">a: int,
              b,
              c: float) -&gt; str</span></span>
            </h3>
            <p>Detailed param docs and annotations</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First parameter</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>The second one is different from <code>a</code></td>
                </tr>
                <tr>
                  <td>c</td>
                  <td>And a <code>float</code></td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>String, of course, it's all <em>stringly</em> typed</td>
                </tr>
              </tfoot>
            </table>
<p>Type annotations and param list in detailed docs.</p>
          </div></section>
          <section class="m-doc-details" id="param_docs_wrong"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#param_docs_wrong" class="m-doc-self">param_docs_wrong</a>(</span><span class="m-doc-wrap">a, b)</span></span>
            </h3>
            <p>Should give warnings</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td></td>
                </tr>
              </tbody>
            </table>
<p>The <code>b</code> is not documented, while <code>c</code> isn't in the signature.</p>
          </div></section>
          <section class="m-doc-details" id="this_function_has_bad_docs"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#this_function_has_bad_docs" class="m-doc-self">this_function_has_bad_docs</a>(</span><span class="m-doc-wrap">a, b)</span></span>
            </h3>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td></td>
                </tr>
                <tr>
                  <td>b</td>
                  <td></td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
        <section>
          <h2>Data documentation</h2>
          <section class="m-doc-details" id="DATA_WITH_DETAILS"><div>
            <h3>
              content.<wbr /><a href="#DATA_WITH_DETAILS" class="m-doc-self">DATA_WITH_DETAILS</a>: str
            </h3>
            <p>This is finally a docstring for <a class="m-doc" href="content.html#DATA_WITH_DETAILS">DATA_WITH_DETAILS</a></p>
<p>Detailed docs for the data. <strong>YAY.</strong></p>
          </div></section>
          <section class="m-doc-details" id="DATA_WITH_DETAILS_BUT_NO_SUMMARY_NEITHER_TYPE"><div>
            <h3>
              content.<wbr /><a href="#DATA_WITH_DETAILS_BUT_NO_SUMMARY_NEITHER_TYPE" class="m-doc-self">DATA_WITH_DETAILS_BUT_NO_SUMMARY_NEITHER_TYPE</a>
            </h3>
<p>Why it has to be yelling?!</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
